[Swift / SPM] パッケージを自作して、アプリに取り入れる方法を簡単にまとめてみた

#Swift

中安佑一

2023.03.10

この記事は公開されてから1年以上経過しています。情報が古い可能性がありますので、ご注意ください。

はじめに

CX事業本部の中安です。まいどです。

いくつかアプリを作っていると「この処理、前も書いたなー」とか「同じようなクラス作ったなー」などということがよくあり、どうせ同じものを作るなら共通化したいなーと思ようになります。

そこで、いつも作るような処理をパッケージとしてまとめて、各アプリでSwift Package Manager的にライブラリ化を目指すことにしました。

今記事では、パッケージの作成からリリース、使用するまでの流れをまとめてみたいと思います。

準備

GitHubにリポジトリを作る

あまり詳しく説明は書きません。シンプルにGitHubにリポジトリを作るだけです。

Swift用の.gitignoreとREADME.mdは最初から用意しておきます。(GitHub側で追加した状態でInitial Commitできます)

パッケージを作る

リポジトリができたらパッケージを実際に作る手順に入ります。ターミナルで以下のような流れになります。

# パッケージを作りたいディレクトリに移動します
% cd (ディレクトリパス)

# 作ったGitHubのリポジトリをクローンします
% git clone git@github.com:(ユーザ名)/(リポジトリ名).git

# クローンされたらその中に入ります
% cd (リポジトリ名)

# Swift Package の初期化をします
% swift package init --type library --name (パッケージ名)

# Package.swiftを開くことでXcodeを起動します。
% open Package.swift

iOS用に色々といじる

Xcodeが開かれると上部の実行する環境が「My Mac」になってると思います。このままだとUIKitなどのiOS用フレームワークを使おうとするとエラーになってしまうので、iPhoneシミュレータに変えてしまいます(種類はおそらく問わない)。

初期化時にSources/(パッケージ名)/(パッケージ名).swiftが作られていて、Xcodeで開くと下記のようなサンプルコードが書かれていると思います。

public struct (パッケージ名) {
    public private(set) var text = "Hello, World!"

    public init() {
    }
}

ここの先頭行に

import UIKit

を追加して、ビルドをしてみてUIKitについてエラーにならなければOKと思います。

プラットフォームを限定する

iOS用のパッケージとして特化するのであれば、プラットフォームを限定しておいた方がいいかもしれません。ここを指定しておけば下位のiOSバージョンとの互換も考えずに済むと思います。

Package.swiftにハイライトした部分を書き加えます。

// swift-tools-version: 5.7
// The swift-tools-version declares the minimum version of Swift required to build this package.

import PackageDescription

let package = Package(
    name: "(パッケージ名)",
    platforms: [
        .iOS(.v16)
    ],
    products: [
        // Products define the executables and libraries a package produces, and make them visible to other packages.
        .library(
            name: "(パッケージ名)",
            targets: ["(パッケージ名)"]),
    ],
    dependencies: [
    :
    (以下略)